Skip to content

docs: Added examples for cli flags usage #2713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: Added examples for cli flags usage #2713

wants to merge 4 commits into from
+99 −2

Conversation

Omswastik-11
Copy link

What this PR does / why we need it ?
Adds CLI examples for various flag types (bool, int, string, duration, list), including the previously undocumented --metric-labels-allowlist. Without these examples users can miss important configuration options (see issue #2043).

How does this change affect the cardinality of KSM ?
No effect on KSM functionality or metric cardinality—it’s purely a docs enhancement.

Which issue(s) this PR fixes ?
Fixes #2043

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Omswastik-11
Once this PR has been reviewed and has the lgtm label, please assign rexagod for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot requested review from dgrisonnet and mrueg July 30, 2025 09:38
@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Jul 30, 2025 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jul 30, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @Omswastik-11!

It looks like this is your first PR to kubernetes/kube-state-metrics 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kube-state-metrics has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jul 30, 2025
@Omswastik-11 Omswastik-11 changed the title Added examples for cli flags usage docs: Added examples for cli flags usage Jul 30, 2025
CatherineF-dev
CatherineF-dev reviewed Jul 30, 2025
View reviewed changes
@CatherineF-dev
Copy link
Contributor

Thanks! Overall LGTM!

Only few comments on markdown format https://github.com/kubernetes/kube-state-metrics/blob/6a99244f508ca25e122232bb352cc29a69231c6f/docs/developer/cli-arguments.md

@CatherineF-dev
Copy link
Contributor

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jul 30, 2025
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 31, 2025
@Omswastik-11
Copy link
Author

Omswastik-11 commented Jul 31, 2025 •
edited
Loading

Hi @CatherineF-dev !! Can you review it now ? I made changes as you suggested.
I will be more than happy if you can assign me some other issues . I will be happy to contribute . thanks !! :)

mrueg
mrueg reviewed Jul 31, 2025
View reviewed changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mrueg mrueg mrueg left review comments

@CatherineF-dev CatherineF-dev CatherineF-dev left review comments

@dgrisonnet dgrisonnet Awaiting requested review from dgrisonnet

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document usage examples for cli flags
4 participants
@Omswastik-11 @k8s-ci-robot @CatherineF-dev @mrueg